Resource URL: /platform/<<version=3>>/protocols/ndmp/settings/variables/<path*>

    Overview: This resource applies to manage preferred NDMP environment
              variables.

     Methods: GET, PUT, POST, DELETE

********************************************************************************

Method GET: List of preferred environment variables.

       URL: GET
            /platform/<<version=3>>/protocols/ndmp/settings/variables/<path*>

Query arguments:
  path=<string> Return variables of the path.
limit=<integer> Return no more than this many results at once (see resume).
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "description": "Get list of preferred environment variable.", 
      "properties": {
        "variables": {
          "type": "array", 
          "properties": {
            "path": {
              "type": "string", 
              "description": "Return variables of the backup path."
            }, 
            "id": {
              "type": "string", 
              "description": "The unique display id"
            }, 
            "path_variables": {
              "type": "array", 
              "properties": {
                "name": {
                  "type": "string", 
                  "description": "The name of environment variable."
                }, 
                "value": {
                  "type": "string", 
                  "description": "The value of environment variable."
                }
              }
            }
          }
        }, 
        "total": {
          "type": "integer", 
          "description": "The number of backup paths."
        }, 
        "resume": {
          "type": "string", 
          "description": "Resume string returned by previous query."
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify or create a NDMP preferred environment variable.

       URL: PUT
            /platform/<<version=3>>/protocols/ndmp/settings/variables/<path*>

Query arguments:
name=<string> Name of the variable to modify.

Required PUT request body fields:
value

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "value": {
      "required": true, 
      "type": "string", 
      "description": "The value of environment variable."
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method POST: Create a preferred NDMP environment variable.

        URL: POST
             /platform/<<version=3>>/protocols/ndmp/settings/variables/<path*>

There are no query arguments for this method.

Required POST request body fields:
path, name, value

POST request body schema:
{
  "type": "object", 
  "properties": {
    "path": {
      "required": true, 
      "type": "string", 
      "description": "The backup path."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "The name of environment variable."
    }, 
    "value": {
      "required": true, 
      "type": "string", 
      "description": "The value of environment variable."
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": [
        "null", 
        "object"
      ], 
      "description": "Null or any empty JSON object.", 
      "properties": {}
    }
  ]
}

********************************************************************************

Method DELETE: Delete preferred environment variable entries

          URL: DELETE
               /platform/<<version=3>>/protocols/ndmp/settings/variables/<path*>

Query arguments:
name=<string> Name of the variable to delete.

There is no JSON response body for this method.
